Power Step Click Driver

API for configuring and manipulating Power Step Click driver. More...

Topics
	Power Step Settings
	Settings of Power Step Click driver.
	Power Step MikroBUS Map
	MikroBUS pin mapping of Power Step Click driver.

Functions
void	powerstep_cfg_setup (powerstep_cfg_t *cfg)
	Power Step configuration object setup function.
err_t	powerstep_init (powerstep_t *ctx, powerstep_cfg_t *cfg)
	Power Step initialization function.
void	powerstep_enable_device (powerstep_t *ctx)
	Power Step enable device function.
void	powerstep_disable_device (powerstep_t *ctx)
	Power Step disable device function.
void	powerstep_set_direction (powerstep_t *ctx, uint8_t dir)
	Power Step set direction function.
void	powerstep_switch_direction (powerstep_t *ctx)
	Power Step switch direction function.
void	powerstep_set_rst_pin (powerstep_t *ctx, uint8_t state)
	Power Step set rst pin function.
void	powerstep_reset_device (powerstep_t *ctx)
	Power Step reset device function.
void	powerstep_set_step_pin (powerstep_t *ctx, uint8_t state)
	Power Step set step pin function.
void	powerstep_drive_motor (powerstep_t *ctx, uint32_t steps, uint8_t speed)
	Power Step driver motor function.

Detailed Description

API for configuring and manipulating Power Step Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

powerstep_cfg_setup()

void powerstep_cfg_setup

(

powerstep_cfg_t *

cfg

)

Power Step configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See powerstep_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

powerstep_disable_device()

void powerstep_disable_device

(

powerstep_t *

ctx

)

Power Step disable device function.

This function disables the device output by setting the EN pin to high logic state.

Parameters

[in]

ctx

: Click context object. See powerstep_t object definition for detailed explanation.

Returns

None.

Note

None.

powerstep_drive_motor()

void powerstep_drive_motor	(	powerstep_t *	ctx,
		uint32_t	steps,
		uint8_t	speed )

Power Step driver motor function.

This function drives the motor for the specific number of steps at the selected speed.

Parameters

[in]	ctx	: Click context object. See powerstep_t object definition for detailed explanation.
[in]	steps	: Number of steps to rotate motor.
[in]	speed	: Motor rotation speed: 0 - Very slow, 1 - Slow, 2 - Medium, 3 - Fast, 4 - Very fast,

Returns

None.

Note

None.

powerstep_enable_device()

void powerstep_enable_device

(

powerstep_t *

ctx

)

Power Step enable device function.

This function enables the device output by setting the EN pin to low logic state.

Parameters

[in]

ctx

: Click context object. See powerstep_t object definition for detailed explanation.

Returns

None.

Note

None.

powerstep_init()

err_t powerstep_init	(	powerstep_t *	ctx,
		powerstep_cfg_t *	cfg )

Power Step initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See powerstep_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See powerstep_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

powerstep_reset_device()

void powerstep_reset_device

(

powerstep_t *

ctx

)

Power Step reset device function.

This function resets the device by setting the RST pin logic state.

Parameters

[in]

ctx

: Click context object. See powerstep_t object definition for detailed explanation.

Returns

None.

Note

None.

powerstep_set_direction()

void powerstep_set_direction	(	powerstep_t *	ctx,
		uint8_t	dir )

Power Step set direction function.

This function sets the motor direction by setting the DIR pin logic state.

Parameters

[in]	ctx	: Click context object. See powerstep_t object definition for detailed explanation.
[in]	dir	: 0 - Clockwise, 1 - Counter-Clockwise.

Returns

None.

Note

None.

powerstep_set_rst_pin()

void powerstep_set_rst_pin	(	powerstep_t *	ctx,
		uint8_t	state )

Power Step set rst pin function.

This function sets the RST pin logic state.

Parameters

[in]	ctx	: Click context object. See powerstep_t object definition for detailed explanation.
[in]	state	: 0 - Low logic state, 1 - High logic state.

Returns

None.

Note

None.

powerstep_set_step_pin()

void powerstep_set_step_pin	(	powerstep_t *	ctx,
		uint8_t	state )

Power Step set step pin function.

This function sets the STEP pin logic state.

Parameters

[in]	ctx	: Click context object. See powerstep_t object definition for detailed explanation.
[in]	state	: 0 - Low logic state, 1 - High logic state.

Returns

None.

Note

None.

powerstep_switch_direction()

void powerstep_switch_direction

(

powerstep_t *

ctx

)

Power Step switch direction function.

This function switches the motor direction by toggling the DIR pin.

Parameters

[in]

ctx

: Click context object. See powerstep_t object definition for detailed explanation.

Returns

None.

Note

None.